home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3x / curs_addch.z / curs_addch
Encoding:
Text File  |  1998-10-20  |  11.7 KB  |  129 lines

  1.  
  2.  
  3.  
  4. ccccuuuurrrrssss____aaaaddddddddcccchhhh((((3333XXXX))))                                                  ccccuuuurrrrssss____aaaaddddddddcccchhhh((((3333XXXX))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_uuuu_rrrr_ssss______aaaa_dddd_dddd_cccc_hhhh: _aaaa_dddd_dddd_cccc_hhhh, _wwww_aaaa_dddd_dddd_cccc_hhhh, _mmmm_vvvv_aaaa_dddd_dddd_cccc_hhhh, _mmmm_vvvv_wwww_aaaa_dddd_dddd_cccc_hhhh, _eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr, _wwww_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr - add a
  10.      character (with attributes) to a _cccc_uuuu_rrrr_ssss_eeee_ssss window and advance cursor
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>>
  14.  
  15.      _aaaa_dddd_dddd_cccc_hhhh_((((_cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_hhhh_))))_;;;;
  16.      _wwww_aaaa_dddd_dddd_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_hhhh_))))_;;;;
  17.      _mmmm_vvvv_aaaa_dddd_dddd_cccc_hhhh_((((_iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_hhhh_))))_;;;;
  18.      _mmmm_vvvv_wwww_aaaa_dddd_dddd_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_hhhh_))))_;;;;
  19.      _eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr_((((_cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_hhhh_))))_;;;;
  20.      _wwww_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _cccc_hhhh_))))_;;;;
  21.  
  22. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.      The _aaaa_dddd_dddd_cccc_hhhh, _wwww_aaaa_dddd_dddd_cccc_hhhh, _mmmm_vvvv_aaaa_dddd_dddd_cccc_hhhh, and _mmmm_vvvv_wwww_aaaa_dddd_dddd_cccc_hhhh routines put the character _c_h
  24.      into the window at the current cursor position of the window and advance
  25.      the position of the window cursor.  Their function is similar to that of
  26.      _pppp_uuuu_tttt_cccc_hhhh_aaaa_rrrr.  At the right margin, an automatic newline is performed.  At the
  27.      bottom of the scrolling region, if _ssss_cccc_rrrr_oooo_llll_llll_oooo_kkkk is enabled, the scrolling
  28.      region is scrolled up one line.
  29.  
  30.      If _c_h is a tab, newline, or backspace, the cursor is moved appropriately
  31.      within the window.  A newline also does a _cccc_llll_rrrr_tttt_oooo_eeee_oooo_llll before moving.  Tabs
  32.      are considered to be at every eighth column.  If _c_h is another control
  33.      character, it is drawn in the _^^^^_X notation.  Calling _wwww_iiii_nnnn_cccc_hhhh after adding a
  34.      control character does not return the control character, but instead
  35.      returns the representation of the control character.
  36.  
  37.      Video attributes can be combined with a character by OR-ing them into the
  38.      parameter.  This results in these attributes also being set.  (The intent
  39.      here is that text, including attributes, can be copied from one place to
  40.      another using _iiii_nnnn_cccc_hhhh and _aaaa_dddd_dddd_cccc_hhhh.)  [see _ssss_tttt_aaaa_nnnn_dddd_oooo_uuuu_tttt, predefined video attribute
  41.      constants, on the _cccc_uuuu_rrrr_ssss______aaaa_tttt_tttt_rrrr(3X) page].
  42.  
  43.      The _eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr and _wwww_eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr routines are functionally equivalent to a call
  44.      to _aaaa_dddd_dddd_cccc_hhhh followed by a call to _rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, or a call to _wwww_aaaa_dddd_dddd_cccc_hhhh followed by a
  45.      call to _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh.  The knowledge that only a single character is being
  46.      output is taken into consideration and, for non-control characters, a
  47.      considerable performance gain might be seen by using these routines
  48.      instead of their equivalents.
  49.  
  50.    LLLLiiiinnnneeee GGGGrrrraaaapppphhhhiiiiccccssss
  51.      The following variables may be used to add line drawing characters to the
  52.      screen with routines of the _aaaa_dddd_dddd_cccc_hhhh family.  When variables are defined for
  53.      the terminal, the _AAAA______AAAA_LLLL_TTTT_CCCC_HHHH_AAAA_RRRR_SSSS_EEEE_TTTT bit is turned on [see _cccc_uuuu_rrrr_ssss______aaaa_tttt_tttt_rrrr(3X)].
  54.      Otherwise, the default character listed below is stored in the variable.
  55.      The names chosen are consistent with the VT100 nomenclature.
  56.  
  57.  
  58.  
  59.                                                                         PPPPaaaaggggeeee 1111
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. ccccuuuurrrrssss____aaaaddddddddcccchhhh((((3333XXXX))))                                                  ccccuuuurrrrssss____aaaaddddddddcccchhhh((((3333XXXX))))
  67.  
  68.  
  69.  
  70.                 _________________________________________________
  71.                  Name           Default   Glyph Description
  72.                  ________________________________________________
  73.                  _AAAA_CCCC_SSSS______UUUU_LLLL_CCCC_OOOO_RRRR_NNNN_EEEE_RRRR   _++++         upper left-hand corner
  74.                  _AAAA_CCCC_SSSS______LLLL_LLLL_CCCC_OOOO_RRRR_NNNN_EEEE_RRRR   _++++         lower left-hand corner
  75.                  _AAAA_CCCC_SSSS______UUUU_RRRR_CCCC_OOOO_RRRR_NNNN_EEEE_RRRR   _++++         upper right-hand corner
  76.                  _AAAA_CCCC_SSSS______LLLL_RRRR_CCCC_OOOO_RRRR_NNNN_EEEE_RRRR   _++++         lower right-hand corner
  77.                  _AAAA_CCCC_SSSS______RRRR_TTTT_EEEE_EEEE       _++++         right tee (-|)
  78.                  _AAAA_CCCC_SSSS______LLLL_TTTT_EEEE_EEEE       _++++         left tee (|-)
  79.                  _AAAA_CCCC_SSSS______BBBB_TTTT_EEEE_EEEE       _++++         bottom tee (_|)
  80.                  _AAAA_CCCC_SSSS______TTTT_TTTT_EEEE_EEEE       _++++         top tee (_|)
  81.                  _AAAA_CCCC_SSSS______HHHH_LLLL_IIII_NNNN_EEEE      _----         horizontal line
  82.                  _AAAA_CCCC_SSSS______VVVV_LLLL_IIII_NNNN_EEEE      _||||         vertical line
  83.                  _AAAA_CCCC_SSSS______PPPP_LLLL_UUUU_SSSS       _++++         plus
  84.                  _AAAA_CCCC_SSSS______SSSS_1111         _----         scan line 1
  85.                  _AAAA_CCCC_SSSS______SSSS_9999         _____         scan line 9
  86.                  _AAAA_CCCC_SSSS______DDDD_IIII_AAAA_MMMM_OOOO_NNNN_DDDD    _++++         diamond
  87.                  _AAAA_CCCC_SSSS______CCCC_KKKK_BBBB_OOOO_AAAA_RRRR_DDDD    _::::         checker board (stipple)
  88.                  _AAAA_CCCC_SSSS______DDDD_EEEE_GGGG_RRRR_EEEE_EEEE     _''''         degree symbol
  89.                  _AAAA_CCCC_SSSS______PPPP_LLLL_MMMM_IIII_NNNN_UUUU_SSSS    _####         plus/minus
  90.                  _AAAA_CCCC_SSSS______BBBB_UUUU_LLLL_LLLL_EEEE_TTTT     _oooo         bullet
  91.                  _AAAA_CCCC_SSSS______LLLL_AAAA_RRRR_RRRR_OOOO_WWWW     _<<<<         arrow pointing left
  92.                  _AAAA_CCCC_SSSS______RRRR_AAAA_RRRR_RRRR_OOOO_WWWW     _>>>>         arrow pointing right
  93.                  _AAAA_CCCC_SSSS______DDDD_AAAA_RRRR_RRRR_OOOO_WWWW     _vvvv         arrow pointing down
  94.                  _AAAA_CCCC_SSSS______UUUU_AAAA_RRRR_RRRR_OOOO_WWWW     _^^^^         arrow pointing up
  95.                  _AAAA_CCCC_SSSS______BBBB_OOOO_AAAA_RRRR_DDDD      _####         board of squares
  96.                  _AAAA_CCCC_SSSS______LLLL_AAAA_NNNN_TTTT_EEEE_RRRR_NNNN    _####         lantern symbol
  97.                  _AAAA_CCCC_SSSS______BBBB_LLLL_OOOO_CCCC_KKKK      _####         solid square block
  98.                  ________________________________________________
  99.  
  100. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  101.      All routines return the integer _EEEE_RRRR_RRRR upon failure and an integer value
  102.      other than _EEEE_RRRR_RRRR upon successful completion, unless otherwise noted in the
  103.      preceding routine descriptions.
  104.  
  105. NNNNOOOOTTTTEEEESSSS
  106.      The header file _cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh automatically includes the header files _ssss_tttt_dddd_iiii_oooo_...._hhhh
  107.      and _uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh.
  108.  
  109.      Note that _aaaa_dddd_dddd_cccc_hhhh, _mmmm_vvvv_aaaa_dddd_dddd_cccc_hhhh, _mmmm_vvvv_wwww_aaaa_dddd_dddd_cccc_hhhh, and _eeee_cccc_hhhh_oooo_cccc_hhhh_aaaa_rrrr may be macros.
  110.  
  111. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  112.      _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______aaaa_tttt_tttt_rrrr(3X), _cccc_uuuu_rrrr_ssss______cccc_llll_eeee_aaaa_rrrr(3X), _cccc_uuuu_rrrr_ssss______iiii_nnnn_cccc_hhhh(3X),
  113.      _cccc_uuuu_rrrr_ssss______oooo_uuuu_tttt_oooo_pppp_tttt_ssss(3X), _cccc_uuuu_rrrr_ssss______rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh(3X) _pppp_uuuu_tttt_cccc(3S)
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                                                                         PPPPaaaaggggeeee 2222
  125.  
  126.  
  127.  
  128.